Skip to content

Add ServiceBusJmsConnectionFactoryClassProvider for custom factory injection#47161

Closed
Copilot wants to merge 4 commits into
mainfrom
copilot/inject-subclass-into-configuration
Closed

Add ServiceBusJmsConnectionFactoryClassProvider for custom factory injection#47161
Copilot wants to merge 4 commits into
mainfrom
copilot/inject-subclass-into-configuration

Conversation

Copilot AI commented Nov 5, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Users need to inject custom subclasses of ServiceBusJmsConnectionFactory to extend JMS functionality beyond the standard implementation. The existing autoconfiguration hardcoded the factory class, preventing this customization.

Changes

  • Added ServiceBusJmsConnectionFactoryClassProvider interface - Functional interface in public API package allowing users to specify their desired ServiceBusJmsConnectionFactory subclass
  • Modified ServiceBusJmsConnectionFactoryConfiguration - Updated createServiceBusJmsConnectionFactory() to check for provider bean and use supplied class if available, defaulting to standard class otherwise
  • Added test coverage - Verified custom factory works with direct connections, caching, and pooling scenarios

Usage

Implement the provider interface as a bean to inject your custom factory:

@Configuration
public class CustomJmsConfiguration {
    @Bean
    public ServiceBusJmsConnectionFactoryClassProvider connectionFactoryClassProvider() {
        return () -> CustomServiceBusJmsConnectionFactory.class;
    }
}

public class CustomServiceBusJmsConnectionFactory extends ServiceBusJmsConnectionFactory {
    public CustomServiceBusJmsConnectionFactory(String connectionString, 
                                                ServiceBusJmsConnectionFactorySettings settings) {
        super(connectionString, settings);
        // Add custom initialization
    }
    
    public CustomServiceBusJmsConnectionFactory(TokenCredential tokenCredential, 
                                                String host, 
                                                ServiceBusJmsConnectionFactorySettings settings) {
        super(tokenCredential, host, settings);
        // Add custom initialization
    }
}

Custom class must extend ServiceBusJmsConnectionFactory and provide both constructors for connection string and passwordless authentication modes.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • login.microsoftonline.com
  • oss.jfrog.org
    • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.11/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.11/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.11 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.11/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/azure-sdk-for-java/azure-sdk-for-java/sdk/spring/spring-cloud-azure-autoconfigure org.codehaus.plexus.classworlds.launcher.Launcher test -Dtest=ServiceBusJmsConnectionFactoryConfigurationTests -DfailIfNoTests=false (dns block)
  • sample-propertysource.vault.azure.net
    • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java -Xmx4096m -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/home/REDACTED/work/azure-sdk-for-java/azure-sdk-for-java/sdk/spring/spring-cloud-azure-autoconfigure/target/spring-cloud-azure-autoconfigure-oom.hprof -XX:+CrashOnOutOfMemoryError --add-opens java.base/java.lang.invoke=com.azure.core org.apache.maven.surefire.booter.ForkedBooter /home/REDACTED/work/azure-sdk-for-java/azure-sdk-for-java/sdk/spring/spring-cloud-azure-autoconfigure/target/surefire 2025-11-05T03-57-12_406-jvmRun1 surefire-20251105035712479_1tmp surefire_0-20251105035712479_2tmp (dns block)
  • sample.servicebus.windows.net
  • sample.somelocation.eventgrid.azure.net
    • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java -Xmx4096m -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/home/REDACTED/work/azure-sdk-for-java/azure-sdk-for-java/sdk/spring/spring-cloud-azure-autoconfigure/target/spring-cloud-azure-autoconfigure-oom.hprof -XX:+CrashOnOutOfMemoryError --add-opens java.base/java.lang.invoke=com.azure.core org.apache.maven.surefire.booter.ForkedBooter /home/REDACTED/work/azure-sdk-for-java/azure-sdk-for-java/sdk/spring/spring-cloud-azure-autoconfigure/target/surefire 2025-11-05T03-57-12_406-jvmRun1 surefire-20251105035712479_1tmp surefire_0-20251105035712479_2tmp (dns block)
  • sample.vault.azure.net
    • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java -Xmx4096m -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/home/REDACTED/work/azure-sdk-for-java/azure-sdk-for-java/sdk/spring/spring-cloud-azure-autoconfigure/target/spring-cloud-azure-autoconfigure-oom.hprof -XX:+CrashOnOutOfMemoryError --add-opens java.base/java.lang.invoke=com.azure.core org.apache.maven.surefire.booter.ForkedBooter /home/REDACTED/work/azure-sdk-for-java/azure-sdk-for-java/sdk/spring/spring-cloud-azure-autoconfigure/target/surefire 2025-11-05T03-57-12_406-jvmRun1 surefire-20251105035712479_1tmp surefire_0-20251105035712479_2tmp (dns block)
  • test-namespace.servicebus.windows.net

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>[FEATURE REQ] Make it possible to inject desired subclass of ServiceBusJmsConnectionFactory into the configuration</issue_title>
<issue_description>Is your feature request related to a problem? Please describe.
For our projects we have wrapper classes for several of the relevant JMS classes to provide additional functionality besides the standard stuff in servicebus.
We therefore want to have our own ServiceBusConnectionFactory to generate our ServiceBusConnecion subclass.

Describe the solution you'd like
We copied the existing ServiceBusJmsConnectionFactoryConfiguration and ServiceBusJmsConnectionFactoryFactory and with very small changes were able to get the desired outcome.
The existing configuration code is pretty much already prepared for this improvement, all that is needed is a way to provide the desired class.
Core to the solution is a very simple interface that can be implemented as a bean to state the desired class.
PR will be provided.

Describe alternatives you've considered

Additional context
The servicebus configuration is very similar to the one for Artemis and since we use both this functionality is requested there too.
In case you come up with a different (read better) solution this should be coordinated with the Spring Boot Autoconfiguration/Artemis team.

Information Checklist
Kindly make sure that you have added all the following information above and checkoff the required fields otherwise we will treat the issuer as an incomplete report

  • Description Added
  • Expected solution specified
    </issue_description>

Comments on the Issue (you are @copilot in this section)

@alzimmermsft @saragluna could you follow-up here @Netyyyy We will close this issue as it has been open for a while. If you have any further questions or need assistance, please feel free to reopen it. Thank you!

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits November 5, 2025 03:43
@saragluna
Add ServiceBusJmsConnectionFactoryClassProvider interface for custom …
862857e 
…factory injection

Co-authored-by: saragluna <31124698+saragluna@users.noreply.github.com>
@saragluna
Fix checkstyle violations by adding suppression for RedundantModifier
5c21d44 
Co-authored-by: saragluna <31124698+saragluna@users.noreply.github.com>
@saragluna
Add comprehensive JavaDoc documentation with usage examples
804b1be 
Co-authored-by: saragluna <31124698+saragluna@users.noreply.github.com>
Copilot AI changed the title [WIP] Add functionality to inject ServiceBusJmsConnectionFactory subclass Add ServiceBusJmsConnectionFactoryClassProvider for custom factory injection Nov 5, 2025
Copilot AI requested a review from saragluna November 5, 2025 03:59
@github-actions

github-actions Bot commented Jan 16, 2026

Copy link
Copy Markdown
Contributor

Hi @copilot. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

2 similar comments
@github-actions

github-actions Bot commented Mar 20, 2026

Copy link
Copy Markdown
Contributor

Hi @copilot. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

@github-actions

github-actions Bot commented May 22, 2026

Copy link
Copy Markdown
Contributor

Hi @copilot. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

@rujche rujche added azure-spring All azure-spring related issues azure-spring-servicebus Spring service bus related issues. labels Jun 30, 2026
@rujche rujche moved this from Todo to In Progress in Spring Cloud Azure Jun 30, 2026
@rujche rujche added this to the 2026-07 milestone Jun 30, 2026
@rujche

rujche commented Jun 30, 2026

Copy link
Copy Markdown
Member

Use this PR instead: #49676

@rujche rujche closed this Jun 30, 2026
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Spring Cloud Azure Jun 30, 2026
@rujche rujche moved this from Done to Cut in Spring Cloud Azure Jun 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@saragluna saragluna Awaiting requested review from saragluna saragluna is a code owner
@JonathanGiles JonathanGiles Awaiting requested review from JonathanGiles JonathanGiles will be requested when the pull request is marked ready for review JonathanGiles is a code owner
@alzimmermsft alzimmermsft Awaiting requested review from alzimmermsft alzimmermsft will be requested when the pull request is marked ready for review alzimmermsft is a code owner
@srnagar srnagar Awaiting requested review from srnagar srnagar will be requested when the pull request is marked ready for review srnagar is a code owner
@rujche rujche Awaiting requested review from rujche rujche will be requested when the pull request is marked ready for review rujche is a code owner
@Netyyyy Netyyyy Awaiting requested review from Netyyyy Netyyyy will be requested when the pull request is marked ready for review Netyyyy is a code owner
@moarychan moarychan Awaiting requested review from moarychan moarychan will be requested when the pull request is marked ready for review moarychan is a code owner
Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

Assignees

@saragluna saragluna

Copilot code review Copilot

Labels

azure-spring All azure-spring related issues azure-spring-servicebus Spring service bus related issues.

Projects

Spring Cloud Azure
Status: Cut

Milestone

2026-07

Development

Successfully merging this pull request may close these issues.

[FEATURE REQ] Make it possible to inject desired subclass of ServiceBusJmsConnectionFactory into the configuration

3 participants

@rujche @saragluna